Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix function comments based on best practices from Effective Go #46

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix function comments based on best practices from Effective Go #46

wants to merge 1 commit into from

Conversation

CodeLingoBot
Copy link

@CodeLingoBot CodeLingoBot commented Feb 14, 2019 •
edited
Loading

Every exported function in a program should have a doc comment. The first sentence should be a summary that starts with the name being declared.
From effective go.

PR generated by CodeLingo. Install here to drive Continuous Higher Standards.

@CodeLingoBot
Fix function comments based on best practices from Effective Go
8f871b5 
Signed-off-by: CodeLingo Bot <bot@codelingo.io>
@Daanikus
Copy link

Hi there!
Dan from CodeLingo here. This PR is testing out a new service. I'd love to hear your feedback or answer your questions. We're keen to learn how we can best help dev teams without getting in your way.

Dan & the CodeLingo Team

wiless
wiless approved these changes Apr 22, 2020
View reviewed changes
Copy link

@wiless wiless left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellently done!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wiless wiless wiless approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@CodeLingoBot @Daanikus @wiless